Autorizar pagamento recorrente

Esta página irá guiá-lo através das solicitações de autorização usadas pela jornada 1

Solicitação de autorização para pagamento recorrente

Este endpoint é usado para iniciar o processo de autorização, onde o usuário final receberá as informações do contrato inseridas no corpo deste endpoint.

Request

POST 'https://apisandbox.delbank.com.br/baas/api/v1/automatic-pix/authorization'

Headers

Name	Description
x-delbank-api-key	Required. API key
idempotencyKey	Required. Guid

Body

{
  "id": "RR1234567820250429ABCDE122125",
  "frequencyType": 1,
  "startDate": "2025-05-29",
  "endDate": "2025-12-01",
  "amount": 150.75,
  "payer": {
    "ispbCode": "38224857",
    "type": 0,
    "document": 12345678910,
    "branch": "0001",
    "number": "31747"
  },
  "contractNumber": "CONTRATO123",
  "description": "Assinatura Premium"
}

Resposta

O código de status 200 indica sucesso na consulta.

Se a consulta for bem-sucedida, o retorno terá os seguintes campos em formato JSON:

{
"id":"RR0435879820240605njua7shf40o",
"requestId":"70F945C1-9024-4123-1001-A1DE2A0000D1",
"createdAt":"2025-04-13T10:10:05.025Z"
}

Respondendo a solicitação de autorização

Este endpoint permite que o usuário final autorize ou não um contrato.

Request

PUT 'https://apisandbox.delbank.com.br/baas/api/v1/automatic-pix/authorization/:identifier'

Headers

Name	Description
x-delbank-api-key	Required. API key
idempotencyKey	Required. Guid

Path Parameters:

Name	Type	Description
identifier	string	Required. Authorization identifier

Body

{
"id":"RR0435879820240605njua7shf40o",
"authorize":true,
"payerName":"Fulano da Silva",
"payerType":0
}

Resposta

O código de status 200 indica sucesso na consulta.

Se a consulta for bem-sucedida, o retorno terá os seguintes campos em formato JSON:

{
"id":"RR0435879820240605njua7shf40o",
"requestId":"70F945C1-9024-4123-1001-A1DE2A0000D1",
"createdAt":"2025-04-13T10:10:05.025Z"
}